home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 11 / Cream of the Crop 11-1.iso / comm / slip_mud.zip / MUDCAL23.DOC < prev    next >
Text File  |  1995-12-15  |  11KB  |  236 lines
  1.                             MudCaller v2.30
  2.                        Copyright 1993 - Peter Haight
  3.                              Documentation
  4.  
  5. I. Brief Overview
  6. ------------------------------
  7.  
  8.     Mudcaller is a Telnet client that has been specificaly modified to make
  9. working with MUDs easier and quicker. Mudcaller uses Turbo Vision to provide
  10. a simple, graphical windowing environment to enhance MUD playing. MudCaller
  11. works on an Ethernet network that uses the Crynwr Packet Drivers. MudCaller
  12. will NOT work with a modem unless the modem is connected via SLIP with
  13. Crynwr Packet Drivers.
  14.  
  15.     Mudcaller now uses a TCP driver devloped by Peter Tattam which not only
  16. provides multiple TCP/IP/UDP sessions, but also is much faster than many of
  17. the other TCP drivers available. This driver enables Mudcaller to call more
  18. than one MUD simultaneously. More information on this TCP TSR is available
  19. in the file ntcpdrv.doc.
  20.  
  21.     This program is free of charge for anyone who wishes to use it. I would 
  22. like people who do use it to drop me a line via email at psh1@cornell.edu and
  23. let me know that they are using it and whether they like it or not. This 
  24. program may be distributed freely as long as no charge is asked for it use.
  25.  
  26.  
  27. II. Features (v2.30)
  28. ------------------------------
  29.     - Multiple MUD sessions
  30.     - Large scrollback buffer
  31.     - 26 User-defineable Macros
  32.     - 50 User-defineable Responses
  33.     - Word Wrap
  34.     - Logging
  35.     - 'Barebones' telnet support.
  36.  
  37. III. Installation
  38. ------------------------------
  39.     Because of the new TCP driver Mudcaller has a much different installation
  40. procedure than the last version. In order for Mudcaller to work, this is
  41. what has to happen:
  42.     1. Load up Crynwr packet driver (ie. 3c503.com)
  43.     2. Load up TCP driver (ie. NTCPDRV.EXE)
  44.     3. Run Mudcaller
  45.     4. Unload TCP driver. (The TCP driver may interfere with other network
  46.        programs, so you have to unload it when you are done).
  47.  
  48.     In order to facilitate this, I have provide a small installation program
  49. which will create three batch files for you which make it much easier to run
  50. MUDCaller:
  51.  
  52.     The first one will be called TCPLOAD.BAT and will be put in the same
  53.     directory as NTCPDRV.EXE. This batch file loads the TCP driver with your
  54.     configuration.
  55.  
  56.     The second one will be called TCPUNLOAD.BAT and will also be put in the
  57.     same directory as NTCPDRV.EXE. This batch file UNLOADS the TCP driver.
  58.  
  59.     The third batch will be called MUDCAL.BAT and will be put in the
  60.     directory from which INSTALL.EXE is run. MUDCAL.BAT calls TCPLOAD.BAT,
  61.     then it runs MudCaller, then, when you are done, calls TCPUNLOAD.BAT.
  62.  
  63.     The reason for the three batch files is that if you run other programs
  64.     that use the NTCPDRV (like I do) you often want to call TCPLOAD.BAT and
  65.     TCPUNLOAD.BAT for other programs. This makes it very easy.
  66.  
  67. In order to create these files, the installer program needs some information:
  68.     1. It needs a path to the NTCPDRV.EXE file. This can be wherever you
  69.        want. On my system I have it in c:\tcp\
  70.     2. It needs to know whether your system uses BootP or not. BootP is a
  71.        type of Network option that dynamically allocates your IP address and
  72.        also provides you with information about your network like your
  73.        Gateway IP address, your DNS server, your IP address, etc...
  74.        If you don't know whether you have BootP or not, ask the person who
  75.        hooked you up to the network (ie. you system administrator).
  76.        You probably don't have BootP if you already know your IP Address,
  77.        gateway, and DNS server.
  78.     3. If you don't have BootP then the installer will ask you for your
  79.        IP Address, Gateway IP Address, DNS IP Address, and Subnet Mask.
  80.        You should already know these. If you don't you need to ask your
  81.        system administrator what these are. They are all of the form:
  82.        (X.X.X.X) where X is a number from 1 to 255.
  83.     4. The installer will now create your batch files. All you need to
  84.        do now is make sure that your Crynwr Packet Driver is installed.
  85.  
  86. IV. Using MUDCaller
  87. ------------------------------
  88.     Mudcaller is simple to use once it is loaded up (I hope). To call a mud
  89. just pull down the menu File and pick Open, or hit F3. When you do this a
  90. dialog box will pop up which will show you a list of all the MUDS you have
  91. entered. If there are no MUDS entered hit the Add button to add a MUD.
  92. Now you have to enter three things:
  93.     - The name for this MUD (whatever you want to call it).
  94.     - Either its machine name or its IP address.
  95.     - Its port address.
  96. Once you have these entered, press OK to save them.
  97. Now you will be back at the Open Dialog box. Now just pick a MUD from the
  98. list and press OK. Mudcaller will now try to call the MUD. Sometimes if the
  99. MUD is busy or it is not responding Mudcaller will look like it is sitting
  100. there for awhile. It should eventually open a window or give you an error
  101. message.
  102.  
  103.     Once a window is open, you can type in the bottom part of the window to
  104. send stuff to the MUD and everything that the MUD sends is in the top part
  105. of the window.
  106.  
  107.     You can open another session, but choosing File and then Open again or
  108. by pressing F3.
  109.  
  110. V. How to use Features
  111. ------------------------------
  112.     1. Macros
  113.          Right now, Mudcaller can use 26 Macros from Alt-A to Alt-Z.
  114.          (Though, Alt-X will exit the program right now, so don't use it).
  115.          To use a macro, you have to edit the MACROS.DAT file that comes
  116.          with Mudcaller. You can use EDIT which comes with DOS 5.0 to edit
  117.          this file.
  118.          Each line in the file is a MACRO and has the form:
  119.          Alt-?,<string>
  120.          where the ? is a letter from A to Z and the string is whatever you
  121.          want to send to the MUD. If the string contains a | then it will
  122.          send a <CR> or <enter> to the MUD.
  123.          For example:
  124.          Alt-M,n|n|kill squirrel|
  125.          Would be the equivalent of typing:
  126.            n<enter>
  127.            n<enter>
  128.            kill squirrel<enter>
  129.  
  130.     2. Reponses
  131.          These work in much the same way as Macros. These are in a file
  132.          that comes with Mudcaller called RESPONSE.DAT.
  133.          You need to edit this file to make your own responses. The
  134.          form for a response is:
  135.          <string>,,<string>
  136.          Where the first string is the string that Mudcaller looks for and
  137.          the second string is the string that Mudcaller will send.
  138.          Again, a | signifies <enter> to Mudcaller. Note: putting a | in the
  139.          first string will just have it look for a |, there is no way right
  140.          now to make it look for an <enter>.
  141.          For example:
  142.          dogcow,,examine dogcow|
  143.          would send:
  144.            examine dogcow<enter>
  145.          to the MUD whenver it sees the word dogcow come from the mud. Note:
  146.          it is case sensitive.
  147.  
  148.          You can make your own auto-login with this by using this response:
  149.          name:,,Thist|
  150.          Password:,,Lec4ro84a|
  151.  
  152.     3. Logging
  153.          To turn Logging on, press F8 and give it a file name. To turn it
  154.          off, press F8 again. There is no indicator whether logging is on for
  155.      a given window yet. If you hit F8 and you are asked for a file name
  156.      then logging was off. Otherwise it was on.
  157.      Also, if you have multiple windows open and you hit F8 then it will
  158.      log the window you have selected. You can log each window into 
  159.      seperate files.
  160.  
  161. VI. About the Packet Drivers.
  162. ------------------------------
  163.   - This program uses two other programs to access the internet. 
  164.  Crynwr Packet Driver
  165.         The lowest layer is the Crynwr packet driver. This layer directly
  166.         interfaces with either the specific ethernet card that you use or the
  167.     modem that you are using for SLIP. You need to have the specific 
  168.     Crynwr driver for your card in order for Mudcaller to work. You
  169.     can either get the drivers from the internet or perhaps your the
  170.     manufacturer of your card provides one. Look at the file "howtoget.it"
  171.     for more instructions.
  172.  
  173.  Peter Tattam's TCP driver
  174.         The next layer is Peter Tattam's TCP driver. This uses the Crynwr
  175.     packet driver and provides an easy method for programmers to use the
  176.     TCP/IP suite as well as providing a nice method for multiple 
  177.     connections. The version that comes with this program will work with
  178.     any Crynwr packet driver including the slip driver SLIP8250 and
  179.     Peter Tattam's own CSLIPPER.
  180.  
  181.  
  182. VII. History
  183. ------------------------------
  184. v2.30 - Fixed cursor problems.
  185.       - Fixed string length problem. Max length of string is now infinite.        
  186.  
  187. v2.10 - Fixed freezing problem.
  188.       - Added word wrap to windows.
  189.       - Fixed problem with Add Server
  190.  
  191. v2.00 - Fixed <CR> <LF> problem with MUSHES
  192.       - Added Multiple sessions
  193.       - Added Responses
  194.       - Added Macros
  195.       - Added password protection
  196.       - Fixed description cutoffs that happened with some MUDS.
  197.       - Changed MUD window
  198.       - Changed driver to Peter Tattam's driver.
  199.  
  200. VIII. Known Bugs
  201. ------------------------------
  202. v2.30 - Delete Server has not been implemented yet.
  203.       - On some muds if they have a line that is about 78 characters with a
  204.     CR at the end, Mudcaller sometimes wraps it so that one word will 
  205.     appear on the next line.
  206.       - Full telnet support is shakey. It DOES NOT act as a vt100 terminal. In 
  207.     fact it doesn't have any terminal emulation which doesn't make it very 
  208.     nice when just connected to a unix host. Next version may have vt100
  209.     support.
  210.  
  211. X. Extra Info.
  212. ------------------------------
  213.  
  214. I am very intersted in hearing your comments about the program. Please let
  215. me know what you think can be improved, added, and/or fixed. My e-mail
  216. address is psh1@cornell.edu.
  217.  
  218. I'd also like it if you would drop me a line if you use my program, just so
  219. I can get an idea of how many people use it.
  220.  
  221. Please also feel free to write me if you have problems getting the program
  222. to run on your system.
  223.  
  224. IV. DISCLAIMER AND WARNINGS
  225. ------------------------------
  226. DISCLAIMER
  227.    There is no warranty or promise provided with this software. Peter Haight
  228. is not responsible for any damage that may occur as a result of using this
  229. program. YOU USE THIS PROGRAM AT YOUR OWN RISK.
  230.  
  231. YOU MAY NOT modify or sell MudCaller for any reason without the express
  232. permission of Peter Haight.
  233.  
  234. This software is Copyright 1993 by RIH Productions and Peter Haight.
  235.  
  236.